ISSDK  1.8
IoT Sensing Software Development Kit
docs/apirm/ISSDK_Functional_Interface.md
Go to the documentation of this file.
1 ISSDK Functional Interface (Sensor Driver API) {#functionalapis}
2 ==============================================
3 <P>Each Sensor Driver is unique to that driver. There is no abstraction, just a simple set of up to four functions for each sensor: Initialize, Configure, ReadData, and Deinit.
4 ISSDK support following Functional Interface (Sensor Driver API).
5 
6 FXLS8964AF Functional Interface
7 -------------------------------
8 Function | Description
9 ---------|------------
10 [FXLS896x_I2C_Initialize](@ref FXLS896x_I2C_Initialize(fxls896x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8964AF sensor
11 [FXLS896x_I2C_Configure](@ref FXLS896x_I2C_Configure(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8964AF sensor
12 [FXLS896x_I2C_ReadData](@ref FXLS896x_I2C_ReadData(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8964AF sensor data
13 [FXLS896x_I2C_DeInit](@ref FXLS896x_I2C_DeInit(fxls896x_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8964AF sensor.
14 [FXLS896x_SPI_Initialize](@ref FXLS896x_SPI_Initialize(fxls896x_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8964AF sensor
15 [FXLS896x_SPI_Configure](@ref FXLS896x_SPI_Configure(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8964AF sensor
16 [FXLS896x_SPI_ReadData](@ref FXLS896x_SPI_ReadData(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8964AF sensor data
17 [FXLS896x_SPI_Deinit](@ref FXLS896x_SPI_Deinit(fxls896x_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8964AF sensor.
18 
19 FXLS8967AF Functional Interface
20 -------------------------------
21 Function | Description
22 ---------|------------
23 [FXLS896x_I2C_Initialize](@ref FXLS896x_I2C_Initialize(fxls896x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8967AF sensor
24 [FXLS896x_I2C_Configure](@ref FXLS896x_I2C_Configure(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8967AF sensor
25 [FXLS896x_I2C_ReadData](@ref FXLS896x_I2C_ReadData(fxls896x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8967AF sensor data
26 [FXLS896x_I2C_DeInit](@ref FXLS896x_I2C_DeInit(fxls896x_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8967AF sensor.
27 [FXLS896x_SPI_Initialize](@ref FXLS896x_SPI_Initialize(fxls896x_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8967AF sensor
28 [FXLS896x_SPI_Configure](@ref FXLS896x_SPI_Configure(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8967AF sensor
29 [FXLS896x_SPI_ReadData](@ref FXLS896x_SPI_ReadData(fxls896x_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8967AF sensor data
30 [FXLS896x_SPI_Deinit](@ref FXLS896x_SPI_Deinit(fxls896x_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8967AF sensor.
31 
32 FXLS8974CF Functional Interface
33 -------------------------------
34 Function | Description
35 ---------|------------
36 [FXLS8974_I2C_Initialize](@ref FXLS8974_I2C_Initialize(fxls8974_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8974CF sensor
37 [FXLS8974_I2C_Configure](@ref FXLS8974_I2C_Configure(fxls8974_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8974CF sensor
38 [FXLS8974_I2C_ReadData](@ref FXLS8974_I2C_ReadData(fxls8974_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8974CF sensor data
39 [FXLS8974_I2C_DeInit](@ref FXLS8974_I2C_DeInit(fxls8974_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8974CF sensor.
40 [FXLS8974_SPI_Initialize](@ref FXLS8974_SPI_Initialize(fxls8974_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8974CF sensor
41 [FXLS8974_SPI_Configure](@ref FXLS8974_SPI_Configure(fxls8974_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8974CF sensor
42 [FXLS8974_SPI_ReadData](@ref FXLS8974_SPI_ReadData(fxls8974_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the FXLS8974CF sensor data
43 [FXLS8974_SPI_Deinit](@ref FXLS8974_SPI_Deinit(fxls8974_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8974CF sensor.
44 
45 
46 FXAS21002 Functional Interface
47 -------------------------------
48 Function | Description
49 ---------|------------
50 [FXAS21002_I2C_Initialize](@ref FXAS21002_I2C_Initialize(fxas21002_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXAS21002 sensor
51 [FXAS21002_I2C_Configure](@ref FXAS21002_I2C_Configure(fxas21002_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXAS21002 sensor
52 [FXAS21002_I2C_ReadData](@ref FXAS21002_I2C_ReadData(fxas21002_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXAS21002 sensor data
53 [FXAS21002_I2C_Deinit](@ref FXAS21002_I2C_Deinit(fxas21002_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXAS21002 sensor.
54 
55 FXLS8962 Functional Interface
56 -------------------------------
57 Function | Description
58 ---------|------------
59 [FXLS8962_I2C_Initialize](@ref FXLS8962_I2C_Initialize(fxls8962_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t *whoAmi)) | The interface function to initialize the FXLS8962 sensor
60 [FXLS8962_I2C_Configure](@ref FXLS8962_I2C_Configure(fxls8962_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8962 sensor
61 [FXLS8962_I2C_ReadData](@ref FXLS8962_I2C_ReadData(fxls8962_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8962 sensor data
62 [FXLS8962_I2C_DeInit](@ref FXLS8962_I2C_DeInit(fxls8962_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXLS8962 sensor.
63 [FXLS8962_SPI_Initialize](@ref FXLS8962_SPI_Initialize(fxls8962_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t *whoAmi)) | The interface function to initialize the FXLS8962 sensor
64 [FXLS8962_SPI_Configure](@ref FXLS8962_SPI_Configure(fxls8962_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8962 sensor
65 [FXLS8962_SPI_ReadData](@ref FXLS8962_SPI_ReadData(fxls8962_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8962 sensor data
66 [FXLS8962_SPI_Deinit](@ref FXLS8962_SPI_Deinit(fxls8962_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8962 sensor.
67 
68 FXOS8700 Functional Interface
69 -------------------------------
70 Function | Description
71 ---------|------------
72 [FXOS8700_I2C_Initialize](@ref FXOS8700_I2C_Initialize(fxos8700_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXOS8700 sensor
73 [FXOS8700_I2C_Configure](@ref FXOS8700_I2C_Configure(fxos8700_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXOS8700 sensor
74 [FXOS8700_I2C_ReadData](@ref FXOS8700_I2C_ReadData(fxos8700_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXOS8700 sensor data
75 [FXOS8700_I2C_Deinit](@ref FXOS8700_I2C_Deinit(fxos8700_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXOS8700 sensor.
76 
77 MPL3115 Functional Interface
78 -------------------------------
79 Function | Description
80 ---------|------------
81 [MPL3115_I2C_Initialize](@ref MPL3115_I2C_Initialize(mpl3115_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MPL3115 sensor
82 [MPL3115_I2C_Configure](@ref MPL3115_I2C_Configure(mpl3115_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MPL3115 sensor
83 [MPL3115_I2C_ReadData](@ref MPL3115_I2C_ReadData(mpl3115_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MPL3115 sensor data
84 [MPL3115_I2C_DeInit](@ref MPL3115_I2C_DeInit(mpl3115_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MPL3115 sensor.
85 
86 MAG3110 Functional Interface
87 -------------------------------
88 Function | Description
89 ---------|------------
90 [MAG3110_I2C_Initialize](@ref MAG3110_I2C_Initialize(mag3110_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MAG3110 sensor
91 [MAG3110_I2C_Configure](@ref MAG3110_I2C_Configure(mag3110_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MAG3110 sensor
92 [MAG3110_I2C_ReadData](@ref MAG3110_I2C_ReadData(mag3110_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MAG3110 sensor data
93 [MAG3110_I2C_DeInit](@ref MAG3110_I2C_DeInit(mag3110_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MAG3110 sensor.
94 
95 MMA865x Functional Interface
96 -------------------------------
97 Function | Description
98 ---------|------------
99 [MMA865x_I2C_Initialize](@ref MMA865x_I2C_Initialize(mma865x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MMA865X sensor
100 [MMA865x_I2C_Configure](@ref MMA865x_I2C_Configure(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MMA865X sensor
101 [MMA865x_I2C_ReadData](@ref MMA865x_I2C_ReadData(mma865x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA865X sensor data
102 [MMA865x_I2C_DeInit](@ref MMA865x_I2C_DeInit(mma865x_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MMA865X sensor.
103 
104 MMA8491Q Functional Interface
105 -------------------------------
106 Function | Description
107 ---------|------------
108 [MMA8491Q_I2C_Initialize](@ref MMA8491Q_I2C_Initialize(mma8491q_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C* pBus, uint8_t index, uint16_t sAddress)) | The interface function to initialize the MMA8491Q sensor
109 [MMA8491Q_I2C_ReadData](@ref MMA8491Q_I2C_ReadData(mma8491q_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA8491Q sensor data
110 
111 FXLS8471Q Functional Interface
112 -------------------------------
113 Function | Description
114 ---------|------------
115 [FXLS8471Q_SPI_Initialize](@ref FXLS8471Q_SPI_Initialize(fxls8471q_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSlaveSelect, uint8_t whoAmi)) | The interface function to initialize the FXLS8471Q sensor
116 [FXLS8471Q_SPI_Configure](@ref FXLS8471Q_SPI_Configure(fxls8471q_spi_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXLS8471Q sensor
117 [FXLS8471Q_SPI_ReadData](@ref FXLS8471Q_SPI_ReadData(fxls8471q_spi_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXLS8471Q sensor data
118 [FXLS8471Q_SPI_Deinit](@ref FXLS8471Q_SPI_Deinit(fxls8471q_spi_sensorhandle_t *pSensorHandle)) | The interface function to stop the FXLS8471Q sensor.
119 
120 FXLC95000 Functional Interface
121 -------------------------------
122 Function | Description
123 ---------|------------
124 [FXLC95000_SPI_Initialize](@ref FXLC95000_SPI_Initialize(fxlc95000_spi_sensorhandle_t *pSensorHandle, ARM_DRIVER_SPI *pBus, uint8_t index, void *pSpiSelect, void *pSlaveSelect, void *pReset, uint16_t buildId)) | The interface function to initialize the FXLC95000 sensor in SPI mode.
125 [FXLC95000_SPI_CommandResponse](@ref FXLC95000_SPI_CommandResponse(fxlc95000_spi_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pResponseList, uint8_t *pBuffer)) | The interface function to read the FXLC95000 sensor data.
126 [FXLC95000_I2C_Initialize](@ref FXLC95000_I2C_Initialize(fxlc95000_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint16_t buildId)) | The I2C interface function to initialize the FXLC95000 sensor in I2C mode.
127 [FXLC95000_I2C_CommandResponse](@ref FXLC95000_I2C_CommandResponse(fxlc95000_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pResponseList, uint8_t *pBuffer)) | The interface function to read the FXLC95000 sensor data.
128 
129 MMA9553 Functional Interface
130 -------------------------------
131 Function | Description
132 ---------|------------
133 [MMA9553_I2C_Initialize](@ref MMA9553_I2C_Initialize(mma9553_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C* pBus, uint8_t index, uint16_t sAddress)) | The interface function to initialize the MMA9553 sensor
134 [MMA9553_I2C_Configure](@ref MMA9553_I2C_Configure(mma9553_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList)) | The interface function to configure the MMA9553 sensor
135 [MMA9553_I2C_CommandResponse](@ref MMA9553_I2C_CommandResponse(mma9553_i2c_sensorhandle_t *pSensorHandle, const registercommandlist_t *pCommandList, const registerreadlist_t *pReadList, uint8_t *pBuffer)) | The interface function to read the MMA9553 sensor data
136 [MMA9553_I2C_DeInit](@ref MMA9553_I2C_DeInit(mma9553_i2c_sensorhandle_t *pSensorHandle)) | The interface function to stop the MMA9553 sensor.
137 
138 MMA845x Functional Interface
139 -------------------------------
140 Function | Description
141 ---------|------------
142 [MMA845x_I2C_Initialize](@ref MMA845x_I2C_Initialize(mma845x_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the MMA845x sensor
143 [MMA845x_I2C_Configure](@ref MMA845x_I2C_Configure(mma845x_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the MMA845x sensor
144 [MMA845x_I2C_ReadData](@ref MMA845x_I2C_ReadData(mma845x_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the MMA845x sensor data
145 [MMA845x_I2C_Deinit](@ref MMA845x_I2C_Deinit(mma845x_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the MMA845x sensor.
146 
147 FXPQ3115 Functional Interface
148 -------------------------------
149 Function | Description
150 ---------|------------
151 [FXPQ3115_I2C_Initialize](@ref FXPQ3115_I2C_Initialize(fxpq3115_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXPQ3115 sensor
152 [FXPQ3115_I2C_Configure](@ref FXPQ3115_I2C_Configure(fxpq3115_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXPQ3115 sensor
153 [FXPQ3115_I2C_ReadData](@ref FXPQ3115_I2C_ReadData(fxpq3115_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXPQ3115 sensor data
154 [FXPQ3115_I2C_DeInit](@ref FXPQ3115_I2C_DeInit(fxpq3115_i2c_sensorhandle_t *pSensorHandle )) | The interface function to stop the FXPQ3115 sensor.
155 
156 FXPS7250D4 Functional Interface
157 -------------------------------
158 Function | Description
159 ---------|------------
160 [DBAP_I2C_Initialize](@ref DBAP_I2C_Initialize(dbap_i2c_sensorhandle_t *pSensorHandle, ARM_DRIVER_I2C *pBus, uint8_t index, uint16_t sAddress, uint8_t whoAmi)) | The interface function to initialize the FXPS7250D4 sensor
161 [DBAP_I2C_Configure](@ref DBAP_I2C_Configure(dbap_i2c_sensorhandle_t *pSensorHandle, const registerwritelist_t *pRegWriteList)) | The interface function to configure the FXPS7250D4 sensor
162 [DBAP_I2C_ReadData](@ref DBAP_I2C_ReadData(dbap_i2c_sensorhandle_t *pSensorHandle, const registerreadlist_t *pReadList, uint8_t *pBuffer )) | The interface function to read the FXPS7250D4 sensor data
© Copyright 2016-2022 NXP. All Rights Reserved. SPDX-License-Identifier: BSD-3-Clause